Skip to main content

Sync Process Overview

A Sync Process in SyncNow is a job that synchronizes data between two work systems. It can run on a scheduled timer or continuously (continuous sync is available in the enterprise edition).

🧩 Sync Process Components

Each sync process consists of:

  • Connector for Work System A
    The configuration for one of the systems to be synchronized.
  • Connector for Work System B
    The configuration for the other system.
  • Mapping Definition
    Defines how entities and fields are mapped between the two systems. This can be:
    • Created from a template
    • Customized for the process
    • Inherited from a global mapping

🔗 Sync Process and Mapping

Sync Process Mapping

SyncNow mapping defines the entity types and field mappings between work systems. A sync process can use:

  1. Local Mapping – Custom mapping specific to this process.
  2. Template Mapping – Use a predefined Sync Template.
  3. Inherited Mapping – Inherit from a global mapping definition.

Operators can save any mapping as a global template for reuse in other processes.

📝 Process Definition

Process Configuration

Every process includes two connectors, each with a unique short name and optional settings:

  • Sub Project – Required for some work systems.
  • Board Name – Used for sprint and board management in certain systems.

Each process also has a name and a short name for easy identification.

🧬 Process Inheritance

A process mapping can inherit from global mappings. You can add local entity or field mapping pairs on top of an inherited mapping.

  • Break Inheritance:
    Use the "break inheritance" button to convert the mapping to a local one, removing inheritance.

✅ Process Validation

Work systems may change over time—fields and entities can be removed or altered. SyncNow includes a validation process to ensure your mapping remains valid. Validation checks that all referenced entities and fields exist.

Process Validation

📤 Exporting and Sharing

You can export a process mapping to a file and import it into another sync process—either within your organization or in another SyncNow deployment.

Exporting and Sharing

🗂️ Sync Templates

Sync Templates are reusable, shareable mappings that can be signed, versioned, and verified for security.

  • Sync Processes can be created from a template, which includes predefined entity and field mappings.
  • Note: Sync Templates do not include entity filters, as these are local to each Sync Process.

By understanding these concepts, you can design robust, reusable, and maintainable synchronization processes in SyncNow.